home *** CD-ROM | disk | FTP | other *** search
/ Developer CD Series 1994 November: Tool Chest / Dev.CD Nov 94.toast / New System Software Extensions / OpenDoc A6 / SOM / OpenDoc and SOM / IDL / SUView.idl < prev    next >
Encoding:
Text File  |  1994-04-19  |  3.8 KB  |  176 lines  |  [TEXT/MPS ]
  1. //# Copyright:    © 1993-94 by Apple Computer, Inc., all rights reserved.
  2. #ifndef _SUVIEW_
  3. #define _SUVIEW_
  4.  
  5. #ifndef _ODOBJECT_
  6. #include "ODObject.idl"
  7. #endif
  8.  
  9. #ifndef _STORAGEU_
  10. #include "StorageU.idl"
  11. #endif
  12.  
  13. //==============================================================================
  14. // Classes defined in this interface
  15. //==============================================================================
  16.  
  17. interface   ODStorageUnitView;
  18.  
  19. //==============================================================================
  20. // Classes used by this interface
  21. //==============================================================================
  22.  
  23. interface   ODStorageUnitCursor;
  24.  
  25. //==============================================================================
  26. // ODStorageUnitView
  27. //==============================================================================
  28.  
  29. interface ODStorageUnitView :  ODObject
  30. {
  31.  
  32.     void InitStorageUnitView(in ODStorageUnit storageUnit, 
  33.                             in ODStorageUnitCursor cursor);
  34.         
  35.     ODStorageUnit  GetStorageUnit();
  36.     
  37.     ODStorageUnitCursor  GetCursor();
  38.     
  39.     ODStorageUnitView   Externalize();  
  40.     
  41.     ODStorageUnitView   Internalize();  
  42.     
  43.     ODID GetID();      
  44.     
  45.     ODStorageUnitName GetName();    
  46.     
  47.     void SetName(in ODStorageUnitName name);
  48.     
  49.     ODStorageUnitView  AddProperty(in ODPropertyName propertyName);      
  50.     
  51.     ODStorageUnitView  AddValue(in ODValueType type);
  52.     
  53.     ODStorageUnitView  Remove();
  54.     
  55.     void CopyTo(in ODStorageUnit toSU);
  56.     
  57.     ODStorageUnit  CloneTo(in ODDraftKey key,
  58.                             in ODDraft destDraft, 
  59.                             in ODStorageUnit initiatingFrameSU);
  60.     
  61.     void CloneInto(in ODDraftKey key,
  62.                     in ODStorageUnit destStorageUnit, 
  63.                     in ODStorageUnit initiatingFrameSU);
  64.     
  65.     ODPropertyName  GetProperty();
  66.     
  67.     ODValueType  GetType();
  68.     
  69.     void      SetType(in ODValueType valueType);
  70.     
  71.     void      SetOffset(in ODULong offset);
  72.     
  73.     ODULong    GetOffset();
  74.     
  75.     ODULong    GetValue(in ODULong length, 
  76.                         in ODValue value);
  77.                         
  78.     void      SetValue(in ODULong length, 
  79.                         in ODValue value);
  80.                         
  81.     void      InsertValue(in ODULong length,
  82.                             in ODValue value);
  83.                             
  84.     void      DeleteValue(in ODULong length);
  85.     
  86.     ODULong    GetSize();
  87.     
  88.     ODStorageUnitRef    GetStrongStorageUnitRef(in ODStorageUnit embeddedSU);
  89.     
  90.     ODStorageUnitRef    GetWeakStorageUnitRef(in ODStorageUnit embeddedSU);
  91.     
  92.     ODBoolean      IsStrongStorageUnitRef(in ODStorageUnitRef ref);
  93.     
  94.     ODBoolean      IsWeakStorageUnitRef(in ODStorageUnitRef ref);
  95.     
  96.     ODStorageUnitView   RemoveStorageUnitRef(in ODStorageUnitRef aRef);
  97.     
  98.     ODStorageUnitID  GetIDFromStorageUnitRef(in ODStorageUnitRef aRef);
  99.     
  100.     ODStorageUnitRefIterator  GetStorageUnitRefIterator();
  101.     
  102.     ODULong  GetGenerationNumber();
  103.     
  104.     ODULong  IncrementGenerationNumber();
  105.     
  106.     ODBoolean  IsPromiseValue();
  107.     
  108.     void    SetPromiseValue(in ODValueType valueType,
  109.                             in ODULong offset,
  110.                             in ODULong length,
  111.                             in ODValue value,
  112.                             in ODPart sourcePart);
  113.                             
  114.     ODULong  GetPromiseValue(in ODValueType valueType,
  115.                                 in ODULong offset,
  116.                                 in ODULong length,
  117.                                 in ODValue value,
  118.                                 in ODPart sourcePart);
  119.     
  120.     
  121. #ifdef __SOMIDL__
  122.     implementation
  123.     {
  124.         override:
  125.             somInit,
  126.             somUninit,
  127.             Purge;
  128.         releaseorder:
  129.             InitStorageUnitView,
  130.             GetStorageUnit,
  131.             GetCursor,
  132.             Externalize,
  133.             Internalize,
  134.             GetID,
  135.             GetName,
  136.             SetName,
  137.             AddProperty,
  138.             AddValue,
  139.             Remove,
  140.             CopyTo,
  141.             CloneTo,
  142.             CloneInto,
  143.             GetProperty,
  144.             GetType,
  145.             SetType,
  146.             SetOffset,
  147.             GetOffset,
  148.             GetValue,
  149.             SetValue,
  150.             InsertValue,
  151.             DeleteValue,
  152.             GetSize,
  153.             GetStrongStorageUnitRef,
  154.             GetWeakStorageUnitRef,
  155.             IsStrongStorageUnitRef,
  156.             IsWeakStorageUnitRef,
  157.             RemoveStorageUnitRef,
  158.             GetIDFromStorageUnitRef,
  159.             GetStorageUnitRefIterator,
  160.             GetGenerationNumber,
  161.             IncrementGenerationNumber,
  162.             IsPromiseValue,
  163.             SetPromiseValue,
  164.             GetPromiseValue,
  165.             Lock,
  166.             Unlock;
  167.             
  168.     
  169.   };
  170.   
  171. #endif
  172. };
  173.  
  174. #endif  // _SUVIEW_
  175.  
  176.